home *** CD-ROM | disk | FTP | other *** search
-
-
-
- PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555)))) PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555))))
-
-
-
- NNNNAAAAMMMMEEEE
- ppppmmmmllllaaaauuuunnnncccchhhh - metric specification and scripts for launching other tools
-
- SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h._c_o_m_m_o_n
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c
- $_H_O_M_E/._p_c_p/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c
-
- DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
- This page describes a metrics specification format and a set of scripts
- that can be used by tools to facilitate launching, and being launched by,
- other tools which have no knowledge of each other.
-
- The intended use is for performance tools that are part of, or associated
- with, Performance Co-Pilot (PCP).
-
- A script for the target tool parses the metrics specification and
- generates command line options and/or configuration files for the
- appropriate metrics. For example, ppppmmmmvvvviiiieeeewwww(1) will use the same metrics
- specification when launching tools such as ppppmmmmcccchhhhaaaarrrrtttt(1), ppppmmmmggggssssyyyyssss(1) etc.,
- without any knowledge of how these tools will visualize those metrics.
-
- LLLLAAAAUUUUNNNNCCCCHHHH MMMMEEEENNNNUUUUSSSS
- The launch menu of tools which support the ppppmmmmllllaaaauuuunnnncccchhhh metrics specification
- can be configured to include any selection of IRIX, PCP or other tools.
-
- The launching tool will search /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c and
- $_H_O_M_E/._p_c_p/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c for a list of tools that can be launched.
- The first line of the file specifies the version of ppppmmmmllllaaaauuuunnnncccchhhh that this
- file conforms to. The following lines should contain the menu button name
- followed by the path to a launching script or program, including any
- arguments.
-
- For example, the default /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c will
- contain:
-
- pmlaunch Version 2.0
-
- dkvis _pmview_frontend dkvis
- mpvis _pmview_frontend mpvis
- nfsvis _pmview_frontend nfsvis
- pmchart _pmchart
- pmgsys _pmgadgets_frontend pmgsys
- pmkstat _pmkstat
- pmval _pmval
-
- Empty lines and lines which begin with a ``#'' are ignored.
-
- Menu items with identical names in the second _p_m_l_a_u_n_c_h_r_c file will
- replace the corresponding entries in the first file.
-
-
-
-
-
- PPPPaaaaggggeeee 1111
-
-
-
-
-
-
- PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555)))) PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555))))
-
-
-
- The launching tool will search for the launching script in the directory
- specified in the environment variable PPPPMMMM____LLLLAAAAUUUUNNNNCCCCHHHH____PPPPAAAATTTTHHHH, or
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h if it is not set.
-
- For example, the launch menu of ppppmmmmvvvviiiieeeewwww(1) will contain the entries _d_k_v_i_s,
- _m_p_v_i_s, _n_f_s_v_i_s, _p_m_c_h_a_r_t, _p_m_g_s_y_s, _p_m_k_s_t_a_t and _p_m_v_a_l. If a user selects
- _n_f_s_v_i_s, the script __p_m_v_i_e_w__f_r_o_n_t_e_n_d is executed with the argument _n_f_s_v_i_s.
-
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c is automatically updated by PCP
- products as new tools become available using the script
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_m_k._r_c.
-
- The remainder of this man page describes the metrics specification
- format, and the shell procedures that are provided for extracting the
- relevant information to build a launching script for any tool.
-
- MMMMEEEETTTTRRRRIIIICCCCSSSS SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN FFFFOOOORRRRMMMMAAAATTTT
- The metrics specification which is generated by the launching tool
- contains the minimal information required to display information related
- to the source, domain, color, visual and value semantics, scale and
- groupings of a collection of performance metrics.
-
- To manage later configuration file revisions, the first line of the
- configuration file should be
-
- pmlaunch Version 2.0
-
- All empty lines, or lines beginning with a ``#'' are ignored. A newline
- character separates each statement.
-
- To permit tools to convey update intervals, and other PCP specific
- information, a set of options may be specified with the syntax:
-
- option _v_a_r_i_a_b_l_e=_s_t_r_i_n_g
-
- Any _v_a_r_i_a_b_l_es that are specified are converted to shell variables by the
- shell procedure llllaaaauuuunnnncccchhhh____vvvvaaaarrrr. The following _v_a_r_i_a_b_l_es are commonly used
- between PCP tools, and should have values that may be used in the
- corresponding command line argument. An option without a value is
- equivalent to not setting the variable.
-
- ddddeeeebbbbuuuugggg The current debugging flag used by the launching tool which is
- passed to the target tool as a command line option. Therefore,
- valid values should be a combination of flags identified by
- ppppmmmmddddbbbbgggg(1). Usually associated with a ----DDDD option to PCP tools.
-
- nnnnaaaammmmeeeessssppppaaaacccceeee
- The PCP namespace used by the launching tool. Usually associated
- with a ----nnnn option to PCP tools.
-
-
-
-
-
-
- PPPPaaaaggggeeee 2222
-
-
-
-
-
-
- PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555)))) PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555))))
-
-
-
- ttttiiiimmmmeeeeppppoooorrrrtttt
- The identification of the port used for the time controls (see
- ppppmmmmttttiiiimmmmeeee(1)). Usually associated with a ----pppp option to PCP tools that
- use ppppmmmmttttiiiimmmmeeee(1).
-
- ssssttttaaaarrrrttttttttiiiimmmmeeee
- The starting time of the application in the currently fetched
- contexts. In most cases, this will be the current time on the
- host/s in live mode, or in the archive/s. See PPPPCCCCPPPPIIIInnnnttttrrrroooo(1) for a
- description of time formats. Usually associated with a ----SSSS option
- to PCP tools.
-
- eeeennnnddddttttiiiimmmmeeee
- The finishing time of the application. This is normally only used
- with archives. See PPPPCCCCPPPPIIIInnnnttttrrrroooo(1) for a description of time formats.
- Usually associated with a ----TTTT option to PCP tools.
-
- ooooffffffffsssseeeetttt The starting time as an offset from the ssssttttaaaarrrrttttttttiiiimmmmeeee. See
- PPPPCCCCPPPPIIIInnnnttttrrrroooo(1) for a description of time formats. Usually associated
- with a ----OOOO option to PCP tools.
-
- iiiinnnntttteeeerrrrvvvvaaaallll
- The update interval of the launching application in seconds.
- Usually associated with a ----tttt option to PCP tools.
-
- pppprrrrooooggggnnnnaaaammmmeeee
- The name of the launching tool.
-
- ppppiiiidddd The process ID of the launching tool.
-
- sssseeeelllleeeecccctttteeeedddd
- The metrics are based on a selection in the launching tool if this
- is set to ttttrrrruuuueeee.
-
- ttttiiiimmmmeeeezzzzoooonnnneeee
- The timezone currently in use by the launching tool.
-
- ddddeeeeffffssssoooouuuurrrrcccceeeettttyyyyppppeeee
- The type of the default metrics source in use by the launching
- tool (either hhhh or aaaa).
-
- ddddeeeeffffssssoooouuuurrrrcccceeeennnnaaaammmmeeee
- The name of the default metrics source in use by the launching
- tool (i.e. the name of a host or an archive). Usually associated
- with either the ----aaaa or ----hhhh options to PCP tools.
-
- The launching scripts for a particular application have the option to use
- or ignore these variables as required.
-
- The target PCP and IRIX tools may be static or dynamically configurable.
- Therefore, a reasonable amount of information about each metric is
- required in the metrics specification so that all possible launching
-
-
-
- PPPPaaaaggggeeee 3333
-
-
-
-
-
-
- PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555)))) PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555))))
-
-
-
- scripts can extract what they require. A metric specification must be of
- this format:
-
- mmmmeeeettttrrrriiiicccc _m_e_t_r_i_c__i_d _g_r_o_u_p__i_d _g_r_o_u_p__h_i_n_t _c_o_n_t_e_x_t _s_o_u_r_c_e _h_o_s_t__i_n_f_o
- _n_a_m_e _c_o_l_o_r__s_p_e_c _t_y_p_e _s_e_m_a_n_t_i_c_s _s_c_a_l_e _d_i_m_e_n_s_i_o_n _i_n_d_o_m [[[[_i_n_s_t_a_n_c_e]]]]
-
- The _m_e_t_r_i_c__i_d uniquely identifies the metric within the configuration
- file, so an error is generated if another metric has the same number.
- Ideally, the metric's internal PMID should be used, but is not required
- (see PPPPCCCCPPPPIIIInnnnttttrrrroooo(1)).
-
- Metrics with the same _g_r_o_u_p__i_d should, where possible, be visualized
- together. The _g_r_o_u_p__h_i_n_t gives a hint as to how they should be
- visualized. Hints which could be given include:
-
- nnnnoooonnnneeee Indicates that there is no appropriate hint.
-
- ppppooooiiiinnnntttt Each metric has its own plot. For example, a line in ppppmmmmcccchhhhaaaarrrrtttt(1).
-
- ssssttttaaaacccckkkk The metrics are stacked in a bar plot.
-
- uuuuttttiiiillll The metrics are stacked in a utilization plot which is always
- scaled to 100%.
-
- The metric _c_o_n_t_e_x_t may have one of two values, ``hhhh'' or ``aaaa'' indicating
- either a host or an archive. The host or archive should be specified in
- the _s_o_u_r_c_e. The _h_o_s_t__i_n_f_o for an archive should be the target host of
- the archive. The _h_o_s_t__i_n_f_o for a host should indicate with the value
- ttttrrrruuuueeee that the host must be reached using ppppmmmmssssoooocccckkkkssss(1).
-
- The _n_a_m_e contains the name of the metric, not including any sources or
- instances.
-
- The _c_o_l_o_r__s_p_e_c is used to describe not only the color of the metric, but
- also any scaling that was applied. A _c_o_l_o_r__s_p_e_c must be of one of the
- following formats:
-
- SSSS _c_o_l_o_r,,,,_s_c_a_l_e
- DDDD _c_o_l_o_r,,,,_m_a_x_i_m_u_m,,,,_c_o_l_o_r,,,,_m_a_x_i_m_u_m...
-
- A _c_o_l_o_r__s_p_e_c prefixed with a ``SSSS'' is a static color definition which
- contains only one color and _s_c_a_l_e. This should be used to describe a
- metric which has a fixed color, regardless of its value. A _c_o_l_o_r__s_p_e_c
- with a dynamic color scale is prefixed with a ``DDDD'' character, and will
- change to the next color in the list when the _m_a_x_i_m_u_m value is exceeded.
- The _c_o_l_o_rs may be specified by name or with the XXXX(1) rrrrggggbbbbiiii tuple of three
- normalized floats.
-
- The metric _t_y_p_e and _s_e_m_a_n_t_i_c_s fields have single numeric values which
- respectively map to the PPPPMMMM____TTTTYYYYPPPPEEEE and PPPPMMMM____SSSSEEEEMMMM definitions in
- /_u_s_r/_i_n_c_l_u_d_e/_p_c_p/_p_m_a_p_i._h. The _s_c_a_l_e field comprises three numeric values
- for each of Space, Time, and Count. These fields are extensions to the
-
-
-
- PPPPaaaaggggeeee 4444
-
-
-
-
-
-
- PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555)))) PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555))))
-
-
-
- ppppmmmmllllaaaauuuunnnncccchhhh version 1.0 format (the current version is 2.0). Refer to
- PPPPMMMMAAAAPPPPIIII(3) for detailed descriptions of each of the possible values for
- these fields.
-
- The metric _d_i_m_e_n_s_i_o_ns and internal instance domain identifier (_i_n_d_o_m) are
- described in PPPPMMMMAAAAPPPPIIII(3). The _d_i_m_e_n_s_i_o_n consists of three space-separated
- signed integer values representing Space, Time, and Count respectively.
-
- The _i_n_d_o_m is a single integer. A metric which does not have an instance
- domain should specify an instance domain of ``----''.
-
- The last field in a metric specification is an _i_n_s_t_a_n_c_e. As the _i_n_s_t_a_n_c_e
- may contain most characters, including spaces, the _i_n_s_t_a_n_c_e must be
- enclosed in square brackets. If a metric does not have an instance, then
- the _i_n_s_t_a_n_c_e should simply be ``[[[[]]]]''. Only one _i_n_s_t_a_n_c_e may be
- specified, so multiple instances must be listed as separate metrics on
- subsequent lines in the metrics specification file.
-
- EEEEXXXXAAAAMMMMPPPPLLLLEEEE CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN FFFFIIIILLLLEEEE
- The following text is an example of the possible output generated by
- mmmmppppvvvviiiissss(1):
-
- pmlaunch Version 2.0
-
- metric 0 0 point h omen false kernel.percpu.cpu.idle S rgbi:0.000000/0.782569/0.000000,1000.000000 1 1 0 2 0 0 1 0 4194305 [cpu0]
- metric 1 0 point h omen false kernel.percpu.cpu.wait.total S rgbi:0.000000/0.782569/0.779279,1000.000000 1 1 0 2 0 0 1 0 4194305 [cpu0]
- metric 2 0 point h omen false kernel.percpu.cpu.intr S rgbi:0.750547/0.782569/0.000000,1000.000000 1 1 0 2 0 0 1 0 4194305 [cpu0]
- metric 3 0 point h omen false kernel.percpu.cpu.sys S rgbi:0.750547/0.000000/0.000000,1000.000000 1 1 0 2 0 0 1 0 4194305 [cpu0]
- metric 4 0 point h omen false kernel.percpu.cpu.user S rgbi:0.000000/0.000000/0.779279,1000.000000 1 1 0 2 0 0 1 0 4194305 [cpu0]
-
- option interval=2
- option debug=0
- option timeport=/tmp/pmview.a002ct
- option starttime=@Wed Dec 11 10:14:46 1996
- option offset=@Wed Dec 11 10:14:51 1996
- option timezone=EST-11EST-10,91/2:00,301/2:00
- option progname=pmview
- option pid=10809
- option selected=false
-
-
- FFFFIIIILLLLEEEESSSS
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h
- Directory containing the default scripts and
- configuration files for launching tools.
-
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c
- List of menu items and the corresponding scripts
- for the launching tools.
-
-
-
-
-
-
- PPPPaaaaggggeeee 5555
-
-
-
-
-
-
- PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555)))) PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555))))
-
-
-
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h._c_o_m_m_o_n
- Common shell procedures that can be used for
- generating command line arguments and
- configuration files from a ppppmmmmllllaaaauuuunnnncccchhhh metrics
- specification.
-
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_m_k._r_c
- Script which builds the pmlaunchrc file from the
- component *.menu files (during install).
-
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/*._m_e_n_u
- Generic menu specification files which are
- combined to form the default pmlaunchrc file
- (during install).
-
- $_H_O_M_E/._p_c_p/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c
- User configurable list of menu items and the
- corresponding scripts for the launching tools.
- These items may override those specified in
- /_v_a_r/_p_c_p/_c_o_n_f_i_g/_p_m_l_a_u_n_c_h/_p_m_l_a_u_n_c_h_r_c.
-
-
- EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
- The PPPPCCCCPPPP____SSSSTTTTDDDDEEEERRRRRRRR environment variable described in the DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS section
- below is fully documented in the PPPPCCCCPPPPIIIInnnnttttrrrroooo(1) manual page.
-
- Additional trace and debugging information from the scripts that
- ``launch'' one PCP application from another may be gained as follows:
-
- 1. All trace and debug diagnostic information is added to the end of the
- file named in the environment variable PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH____FFFFIIIILLLLEEEE (or ${_T_M_P_D_I_R-
- /_v_a_r/_t_m_p}/_p_m_l_a_u_n_c_h._t_r_a_c_e by default).
-
- 2. If the environment variable PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH____TTTTRRRRAAAACCCCEEEE is set, then summary
- information is produced for each ``launch'' operation.
-
- 3. If the environment variable PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH____DDDDUUUUMMMMPPPP is set, then the contents
- of various temporary files used in each ``launch'' operation are
- reported.
-
- The launching of a tool can be prevented by setting PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH____CCCCHHHHEEEECCCCKKKK in the
- environment.
-
- SSSSEEEEEEEE AAAALLLLSSSSOOOO
- PPPPCCCCPPPPIIIInnnnttttrrrroooo(1), ppppmmmmcccchhhhaaaarrrrtttt(1), ppppmmmmddddbbbbgggg(1), ppppmmmmggggaaaaddddggggeeeettttssss(1), ppppmmmmggggssssyyyyssss(1), ppppmmmmssssoooocccckkkkssss(1),
- ppppmmmmvvvvaaaallll(1), ppppmmmmvvvviiiieeeewwww(1), xxxxccccoooonnnnffffiiiirrrrmmmm(1) and PPPPMMMMAAAAPPPPIIII(3).
-
- BBBBUUUUGGGGSSSS
- Future versions may allow a hierarchical representation of groups, so
- that groups could contain other groups.
-
-
-
-
-
- PPPPaaaaggggeeee 6666
-
-
-
-
-
-
- PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555)))) PPPPMMMMLLLLAAAAUUUUNNNNCCCCHHHH((((5555))))
-
-
-
- ccccsssshhhh(1) aliases in the user's environment are ignored by most launch
- scripts which determine the path to the target executable using the sssshhhh(1)
- ttttyyyyppppeeee command.
-
- DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
- Error messages produced by any ppppmmmmllllaaaauuuunnnncccchhhh scripts should be self-
- explanatory. These messages will be displayed in an xxxxccccoooonnnnffffiiiirrrrmmmm(1) window
- if DDDDIIIISSSSPPPPLLLLAAAAYYYY is set and PPPPCCCCPPPP____SSSSTTTTDDDDEEEERRRRRRRR is set to ``DISPLAY'' in the environment
- (refer to PPPPMMMMAAAAPPPPIIII(3) for a detailed explanation of this environment
- variable).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- PPPPaaaaggggeeee 7777
-
-
-
-